Fractal Block World
Environment Variables
This documentation was created for the following version of the program: 1.01.29
One can toggle the console (while in game) by pressing the '~' key.
Commands can be entered while in the console. For example, entering the command "exit" will cause the program to exit.
The game has "environment variables" that can be accessed through the console. The "get" command prints the value of the specified environment variable.
The "ls" command lists all variables that start with a given prefix. Note: in addition to environment variables, there are "directories" which are simply a prefix of an environment variable name that ends with a period. The ls command lists variables and directories with the given prefix.
Variables can be changed using the "set" command, assuming you have access to do so. Note that all access is granted by enabling cheat codes.
Environment variables are important because you can set them in the "program_startup" script that is run when the program starts up. You can use this for advanced customization.
This document contains a dump of all environment variables.
This document was created by running the program and calling the "gendoc" console command.
Green entries represent directories, whereas gray ones represent individual environment variables. Some variables or directories are documented with blue text.
package (dir)
package.state (dir)
package.state.input (dir)
package.state.input.binds (dir)
package.state.input.binds.SEMICOLON (dir)
package.state.input.binds.SEMICOLON.downup (string)
package.state.input.binds.RSHIFT (dir)
package.state.input.binds.RSHIFT.downup (string)
package.state.input.binds.RCTRL (dir)
package.state.input.binds.RCTRL.downup (string)
package.state.input.binds.RALT (dir)
package.state.input.binds.RALT.downup (string)
package.state.input.binds.QUOTE (dir)
package.state.input.binds.QUOTE.downup (string)
package.state.input.binds.MOUSE5 (dir)
package.state.input.binds.MOUSE5.downup (string)
package.state.input.binds.MOUSE4 (dir)
package.state.input.binds.MOUSE4.downup (string)
package.state.input.binds.MOUSE3 (dir)
package.state.input.binds.MOUSE3.downup (string)
package.state.input.binds.LEFT (dir)
package.state.input.binds.LEFT.downup (string)
package.state.input.binds.UP (dir)
package.state.input.binds.UP.downup (string)
package.state.input.binds.LALT (dir)
package.state.input.binds.LALT.downup (string)
package.state.input.binds.HOME (dir)
package.state.input.binds.HOME.downup (string)
package.state.input.binds.EQUALS (dir)
package.state.input.binds.EQUALS.downup (string)
package.state.input.binds.COMMA (dir)
package.state.input.binds.COMMA.downup (string)
package.state.input.binds.MOUSEWHEEL_UP (dir)
package.state.input.binds.MOUSEWHEEL_UP.use (string)
package.state.input.binds.MOUSE2 (dir)
package.state.input.binds.MOUSE2.downup (string)
package.state.input.binds.BACKSPACE (dir)
package.state.input.binds.BACKSPACE.downup (string)
package.state.input.binds.SLASH (dir)
package.state.input.binds.SLASH.downup (string)
package.state.input.binds.F12 (dir)
package.state.input.binds.F12.downup (string)
package.state.input.binds.F11 (dir)
package.state.input.binds.F11.downup (string)
package.state.input.binds.F10 (dir)
package.state.input.binds.F10.downup (string)
package.state.input.binds.F8 (dir)
package.state.input.binds.F8.downup (string)
package.state.input.binds.F7 (dir)
package.state.input.binds.F7.downup (string)
package.state.input.binds.MINUS (dir)
package.state.input.binds.MINUS.downup (string)
package.state.input.binds.F6 (dir)
package.state.input.binds.F6.downup (string)
package.state.input.binds.RIGHT (dir)
package.state.input.binds.RIGHT.downup (string)
package.state.input.binds.S (dir)
package.state.input.binds.S.downup (string)
package.state.input.binds.LCTRL (dir)
package.state.input.binds.LCTRL.downup (string)
package.state.input.binds.Q (dir)
package.state.input.binds.Q.downup (string)
package.state.input.binds.P (dir)
package.state.input.binds.P.downup (string)
package.state.input.binds.O (dir)
package.state.input.binds.O.downup (string)
package.state.input.binds.V (dir)
package.state.input.binds.V.downup (string)
package.state.input.binds.SPACE (dir)
package.state.input.binds.SPACE.downup (string)
package.state.input.binds.N (dir)
package.state.input.binds.N.downup (string)
package.state.input.binds.RBRACKET (dir)
package.state.input.binds.RBRACKET.downup (string)
package.state.input.binds.E (dir)
package.state.input.binds.E.downup (string)
package.state.input.binds.U (dir)
package.state.input.binds.U.downup (string)
package.state.input.binds.G (dir)
package.state.input.binds.G.downup (string)
package.state.input.binds.7 (dir)
package.state.input.binds.7.downup (string)
package.state.input.binds.D (dir)
package.state.input.binds.D.downup (string)
package.state.input.binds.L (dir)
package.state.input.binds.L.downup (string)
package.state.input.binds.F (dir)
package.state.input.binds.F.downup (string)
package.state.input.binds.A (dir)
package.state.input.binds.A.downup (string)
package.state.input.binds.B (dir)
package.state.input.binds.B.downup (string)
package.state.input.binds.TAB (dir)
package.state.input.binds.TAB.downup (string)
package.state.input.binds.M (dir)
package.state.input.binds.M.downup (string)
package.state.input.binds.K (dir)
package.state.input.binds.K.downup (string)
package.state.input.binds.H (dir)
package.state.input.binds.H.downup (string)
package.state.input.binds.ENTER (dir)
package.state.input.binds.ENTER.downup (string)
package.state.input.binds.X (dir)
package.state.input.binds.X.downup (string)
package.state.input.binds.Y (dir)
package.state.input.binds.Y.downup (string)
package.state.input.binds.I (dir)
package.state.input.binds.I.downup (string)
package.state.input.binds.W (dir)
package.state.input.binds.W.downup (string)
package.state.input.binds.6 (dir)
package.state.input.binds.6.downup (string)
package.state.input.binds.F9 (dir)
package.state.input.binds.F9.downup (string)
package.state.input.binds.R (dir)
package.state.input.binds.R.downup (string)
package.state.input.binds.J (dir)
package.state.input.binds.J.downup (string)
package.state.input.binds.Z (dir)
package.state.input.binds.Z.downup (string)
package.state.input.binds.MOUSE1 (dir)
package.state.input.binds.MOUSE1.downup (string)
package.state.input.binds.1 (dir)
package.state.input.binds.1.downup (string)
package.state.input.binds.2 (dir)
package.state.input.binds.2.downup (string)
package.state.input.binds.LBRACKET (dir)
package.state.input.binds.LBRACKET.downup (string)
package.state.input.binds.END (dir)
package.state.input.binds.END.downup (string)
package.state.input.binds.DOWN (dir)
package.state.input.binds.DOWN.downup (string)
package.state.input.binds.4 (dir)
package.state.input.binds.4.downup (string)
package.state.input.binds.PERIOD (dir)
package.state.input.binds.PERIOD.downup (string)
package.state.input.binds.8 (dir)
package.state.input.binds.8.downup (string)
package.state.input.binds.0 (dir)
package.state.input.binds.0.downup (string)
package.state.input.binds.GRAVE (dir)
package.state.input.binds.GRAVE.downup (string)
package.state.input.binds.5 (dir)
package.state.input.binds.5.downup (string)
package.state.input.binds.DELETE (dir)
package.state.input.binds.DELETE.downup (string)
package.state.input.binds.BACKSLASH (dir)
package.state.input.binds.BACKSLASH.downup (string)
package.state.input.binds.F1 (dir)
package.state.input.binds.F1.downup (string)
package.state.input.binds.9 (dir)
package.state.input.binds.9.downup (string)
package.state.input.binds.C (dir)
package.state.input.binds.C.downup (string)
package.state.input.binds.ESC (dir)
package.state.input.binds.ESC.downup (string)
package.state.input.binds.T (dir)
package.state.input.binds.T.downup (string)
package.state.input.binds.LSHIFT (dir)
package.state.input.binds.LSHIFT.downup (string)
package.state.input.binds.F2 (dir)
package.state.input.binds.F2.downup (string)
package.state.input.binds.MOUSEWHEEL_DOWN (dir)
package.state.input.binds.MOUSEWHEEL_DOWN.use (string)
package.state.input.binds.F5 (dir)
package.state.input.binds.F5.downup (string)
package.state.input.binds.3 (dir)
package.state.input.binds.3.downup (string)
package.state.input.binds.F3 (dir)
package.state.input.binds.F3.downup (string)
package.state.input.binds.F4 (dir)
package.state.input.binds.F4.downup (string)
package.state.mods (dir)
package.state.mods.selected (string)
package.state.globals (dir)
package.state.globals.sound (dir)
package.state.globals.sound.player_hurt_sounds_enabled (bool)
package.state.globals.render (dir)
package.state.globals.render.levels_fade_out_local (bool)
package.state.globals.render.levels_fade_out_local (bool)
package.state.globals.render.levels_fade_out_local.enabled (bool)
package.state.globals.render.levels_fade_out_local.min_level_shade (float)
package.state.globals.render.levels_fade_out_local.max_level_shade (float)
package.state.globals.movement (dir)
package.state.globals.movement.black_hole_drive (dir)
package.state.globals.movement.black_hole_drive.uses_alt_radius (bool)
package.state.globals.movement.black_hole_drive.alt_radius (int)
package.state.globals.movement.roll (dir)
package.state.globals.movement.roll.drag (float)
package.state.globals.movement.roll.acc (float)
package.state.globals.movement.quasar_drive (dir)
package.state.globals.movement.quasar_drive.uses_alt_radius (bool)
package.state.globals.movement.quasar_drive.alt_radius (int)
package.state.globals.flashes (dir)
package.state.globals.flashes.enable (bool)
package.state.globals.inf2 (dir)
package.state.globals.inf2.can_build_block_into_player (bool)
menu (dir)
menu.render_world_behind (bool)
If true, then when in a main menu, the world will be rendered behind the menu. Note: if the frame rate is too low, the world will NOT be rendered behind the menu.
menu.last_player_name (string)
The player name associated to the last game that was played. This is useful because when the user loads a game, the user will probably want to select this name.
menu.was_in_menu (bool)
True iff last cycle the player was either in the main menu, the console, or a game menu. This is needed because once the player opens some kind of menu from normal gameplay, all the input keys must be "cleared".
menu.back_alpha (float)
The background alpha of windows in the main menu.
menu.in_main (bool)
If true, the game is paused (if there is a game loaded) and the user is in the main menu.
menu.in_package (bool)
If true, the game is paused and the user is in menu that comes with the package.
menu.basic_new_game_menu (bool)
When this is true, when the player starts a new game it will automatically be in the Xar package in the classic configuration with a random seed.
menu.ent_press_key_prompt (bool)
Whether a message appears to use an item (that can be used) when the player has their crosshair on it. This var should probably be removed.
menu.back_alpha_dark (float)
The darker background alpha of windows in the main menu. Some windows have a darker background than others.
menu.back_color (vector)
The background color of windows in the main menu.
menu.in_load_error (bool)
Whether the user is in a menu to deal with an error from loading a game. These menus are essentially popup menus.
menu.text_color (vector)
The color of text in the main menu.
menu.load_error (dir)
If there is an error loading a game, the user must deal with a popup menu. Some of these menus allow the user to resume the load while forcing the value of a var. To resume the load, we must store the params that were passed to the loading function.
menu.load_error.3 (dir)
menu.load_error.3.str (string)
menu.load_error.3.has (bool)
menu.load_error.1 (dir)
menu.load_error.1.override_eng_ver (string)
menu.load_error.1.type_new (bool)
menu.load_error.1.has (bool)
menu.load_error.1.new (dir)
menu.load_error.1.new.world_seed (int)
menu.load_error.1.new.player (string)
menu.load_error.1.new.starting_config_file (string)
menu.load_error.2 (dir)
menu.load_error.2.has (bool)
menu.load_error.2.force_expected_package_ver (string)
menu.load_error.2.force_expected_eng_ver (string)
menu.cursor (dir)
menu.cursor.use_in_windowed_mode (bool)
This specifies whether the cursor is used in windowed mode. See "menu.cursor.use_in_fullscreen_mode".
menu.cursor.use_in_fullscreen_mode (bool)
This specifies whether a cursor is used in the game's main menu while the game is in fullscreen mode. Note that during normal gameplay of the xar package, there is no cursor. Note that it is intended to not use a cursor in fullscreen mode.
menu.colorblind (dir)
menu.colorblind.enable (bool)
menu.colorblind.closest_palette (dir)
menu.colorblind.closest_palette.19 (vector)
menu.colorblind.closest_palette.17 (vector)
menu.colorblind.closest_palette.16 (vector)
menu.colorblind.closest_palette.14 (vector)
menu.colorblind.closest_palette.12 (vector)
menu.colorblind.closest_palette.20 (vector)
menu.colorblind.closest_palette.5 (vector)
menu.colorblind.closest_palette.11 (vector)
menu.colorblind.closest_palette.1 (vector)
menu.colorblind.closest_palette.4 (vector)
menu.colorblind.closest_palette.18 (vector)
menu.colorblind.closest_palette.15 (vector)
menu.colorblind.closest_palette.2 (vector)
menu.colorblind.closest_palette.3 (vector)
menu.colorblind.closest_palette.8 (vector)
menu.colorblind.closest_palette.6 (vector)
menu.colorblind.closest_palette.9 (vector)
menu.colorblind.closest_palette.13 (vector)
menu.colorblind.closest_palette.7 (vector)
menu.colorblind.closest_palette.10 (vector)
menu.load_game (dir)